Send Text SMS

This API is used to send a simple text message to a subscriber.

HTTP URL
POST	/api/v2/subscriber/{type}/{value}/send-text-sms

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
message	String	M	Message verbiage
encoding	String	O	Text message encoding. Range: ‘UCS-2’, Default ‘GSM-7’
expiration	Numeric	O	Set Store & Forward requested time (seconds) when the device is not reachable. Minimum: 120 seconds Maximum: 2678400 seconds Default (if not populated): 7200 seconds

Parameter

Type

M/O/CM

Description

message

String

Message verbiage

encoding

String

Text message encoding.

Range: ‘UCS-2’,

Default ‘GSM-7’

expiration

Numeric

Set Store & Forward requested time (seconds) when the device is not reachable.

Minimum: 120 seconds

Maximum: 2678400 seconds

Default (if not populated): 7200 seconds

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
messageID	UUID	M	SMS delivery ID for delivery notification

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
GLOBAL_1006	Invalid SMSC
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1012	Failed to send SMS

Examples

Request Body

Copy

{
  "message": "Hello",
  "encoding": "GSM-7",
  "expiration": 3000
}

Response Body: Success ACK

Copy

{  
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "messageId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1012",
  "errorMessage": "Failed to send SMS",
  "content": "",
  "pageable": ""
}